All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.app.image.ImageDataSequence

java.lang.Object
   |
   +----quicktime.app.image.ImageDataSequence

public class ImageDataSequence

extends Object

implements ImageSpec, Collection

See Also:

ImageSequencer

ImageDataSequence()

Creates an ImageDataSequence with no settings

ImageDataSequence(ImageDescription)

Creates an ImageDataSequence with an initial description

addMember(Object)

Appends the member to the ImageDataSequence.

addToMovie(Movie, float)

This will insert a video track into the supplied movie with all of the image data that is contained in this data sequence at the specified frames per second.

append(EncodedImage)

Add the image description object to the end of the collection

getDescription()

Returns the ImageDescription object that describes the image data in this sequence.

getImage()

This method returns the actual image data of the first item in the ImageDataSequence.

getImage(int)

This method returns the actual image data at the specified index.

getNth(int)

Gets the image data object at given position.

hasMember(Object)

Returns true if the provided object is a member of the collection.

insert(EncodedImage, int)

Add the image data object at the specified index.

isAppropriate(Object)

Returns true if the provided object is an appropriate candidate for membership in a collection.

isEmpty()

Returns true if the collection contains no members, or false if it has one or more members.

members()

Returns an object that will iterate over the elements in the collection.

prepend(EncodedImage)

Add the image description object as the first item in the collection

remove(int)

Remove the object at the specified index.

removeAll()

Remove all objects.

removeFirst()

Remove the object at the specified index.

removeLast()

Remove the object at the specified index.

removeMember(Object)

If the object is a member of the collection it is removed.

sequence()

Return a Sequencer to iterate over the members of this sequence.

setDescription(ImageDescription)

Sets the ImageDescription object that will describe how the image data objects are to be interpreted by QT.

size()

Determines the number of items.

toString()

Return a string representation of this class

 public ImageDataSequence()

Creates an ImageDataSequence with no settings

 public ImageDataSequence(ImageDescription desc)

Creates an ImageDataSequence with an initial description

Parameters:

desc - the description that will describe the subsequently added image data

 public ImageDescription getDescription()

Returns the ImageDescription object that describes the image data in this sequence.

Returns:

the description

 public void setDescription(ImageDescription desc)

Sets the ImageDescription object that will describe how the image data objects are to be interpreted by QT.

Parameters:

desc - the new description

 public EncodedImage getImage()

This method returns the actual image data of the first item in the ImageDataSequence.

Returns:

the image data

 public EncodedImage getImage(int index)

This method returns the actual image data at the specified index. The index is a one based index. An Exception is throw if there was some problem retrieving the data.

Parameters:

index - is the index to the data frame

Returns:

the image data

 public Enumeration members()

Returns an object that will iterate over the elements in the collection.

Returns:

The iterator.

 public ImageSequencer sequence()

Return a Sequencer to iterate over the members of this sequence.

Returns:

a Sequencer

 public boolean addMember(Object member)

Appends the member to the ImageDataSequence. Adds an object to the collection. Returns true if the object is appropriate member of the collection (and thus added) and false if not.

Parameters:

member - the object that should be added as a member to the collection

Returns:

a boolean.

 public void removeMember(Object member)

If the object is a member of the collection it is removed.

Parameters:

member - the object to remove from the collection

 public boolean isAppropriate(Object object)

Returns true if the provided object is an appropriate candidate for membership in a collection. The provided QTJava collections use this method to ensure a minimal requirement of Class or Interface instanceof tests to ensure the type of object that can be added to a collection. Some collections can have a protocol that allows an application to further refine and tighten the type of object that is allowed within an individual collection.

The member of an ImageDataSequence is an EncodedImage object.

Parameters:

object - the object to test

Returns:

true if the supplied object is appropriate for this collection, or false if not

See Also:

DynamicCollection, Protocol

 public boolean hasMember(Object object)

Returns true if the provided object is a member of the collection.

Parameters:

member - the object to test for membership

Returns:

a boolean

 public void insert(EncodedImage image,
                    int index)

Add the image data object at the specified index. If the index is beyond the end of the collection the image data is appended to the collection.

Parameters:

image - The image data.

index - The position in the sequence to add.

Throws: ArrayIndexOutOfBoundsException

if index value is beyond the size of the collection.

 public void prepend(EncodedImage image)

Add the image description object as the first item in the collection

Parameters:

image - The image data to add.

 public void append(EncodedImage image)

Add the image description object to the end of the collection

Parameters:

image - The image data to add.

 public void remove(int i)

Remove the object at the specified index.

Parameters:

i - The position in the sequence to delete.

Throws: ArrayIndexOutOfBoundsException

if index value is beyond the size of the collection.

 public void removeFirst()

Remove the object at the specified index.

Throws: ArrayIndexOutOfBoundsException

if index value is beyond the size of the collection.

 public void removeLast()

Remove the object at the specified index.

Throws: ArrayIndexOutOfBoundsException

if index value is beyond the size of the collection.

 public void removeAll()

Remove all objects.

 public int size()

Determines the number of items.

Returns:

The size.

 public EncodedImage getNth(int index)

Gets the image data object at given position.

Parameters:

index - Specifies the position in sequence.

Returns:

the image data.

Throws: ArrayIndexOutOfBoundsException

if index value is beyond the size of the collection.

 public boolean isEmpty()

Returns true if the collection contains no members, or false if it has one or more members.

Returns:

a boolean

 public void addToMovie(Movie theMovie,
                        float framesPerSecond) throws QTException

This will insert a video track into the supplied movie with all of the image data that is contained in this data sequence at the specified frames per second.

Parameters:

theMovie - the movie to add the video track to

framesPerSecond - how many frames per second the image data should be inserted at

 public String toString()

Return a string representation of this class

Overrides:

toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index